support to delete pipelinerun by renyunkang · Pull Request #1069 · kubesphere/ks-devops

renyunkang · 2026-03-17T09:00:48Z

What type of PR is this?

/kind feature

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes # https://github.com/kubesphere/project/issues/7185

Special notes for reviewers:

Please check the following list before waiting reviewers:

Already committed the CRD files to the Helm Chart if you created some new CRDs
Already added the permission for the new API
Already added the RBAC markers for the new controllers

Does this PR introduce a user-facing change??

none

gemini-code-assist · 2026-03-17T09:01:04Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces the capability to delete PipelineRun resources, providing a new API endpoint for this operation. It includes robust logic to prevent accidental deletion of active pipeline runs and offers flexibility to retain associated Jenkins build records if desired. The changes ensure proper resource lifecycle management and cleanup within the system.

Highlights

PipelineRun Deletion API: Introduced a new API endpoint to allow for the deletion of PipelineRun resources.
Safe Deletion Logic: Implemented checks to prevent the deletion of PipelineRuns that are still in a running state, ensuring operational stability.
Jenkins Record Retention: Added an option, controlled by an annotation, to specify whether the corresponding Jenkins build record should be kept or deleted when a PipelineRun is removed.
Finalizer Management: Enhanced the PipelineRun controller to properly manage finalizers, ensuring that cleanup operations, such as deleting Jenkins job history, are performed before the PipelineRun object is fully removed from Kubernetes.

Changelog

controllers/jenkins/pipelinerun/pipelinerun_controller.go
- Imported strconv and sliceutil packages.
- Modified the Reconcile function to handle PipelineRun deletion, incorporating logic to check for a keepJenkinsRecord annotation and conditionally delete Jenkins job history.
- Updated finalizer management to ensure the PipelineRunFinalizerName is added if missing and removed upon deletion.
pkg/api/devops/v1alpha3/pipelinerun_types.go
- Added a new constant PipelineRunKeepJenkinsRecordAnnoKey to define the annotation key for retaining Jenkins records.
pkg/kapis/devops/v1alpha3/pipelinerun/handler.go
- Imported the net/http package.
- Implemented the deletePipelineRun handler function, which retrieves a PipelineRun, checks its status to ensure it's not running, applies the keepJenkinsRecord annotation if specified, and then deletes the PipelineRun resource.
pkg/kapis/devops/v1alpha3/pipelinerun/register.go
- Registered a new DELETE route for /namespaces/{namespace}/pipelineruns/{pipelinerun} to expose the deletePipelineRun API endpoint.

Activity

The pull request is categorized as a new feature (/kind feature).
It addresses and fixes issue #7185.
The author has provided a checklist for reviewers to verify CRD files, permissions, and RBAC markers.
The release note for this change is explicitly marked as 'none'.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request adds support for deleting PipelineRun resources. The implementation includes a new API endpoint for deletion, with an option to keep the corresponding Jenkins job history. The controller logic is updated with a finalizer to handle the cleanup of Jenkins resources upon PipelineRun deletion. The changes are well-structured and the logic is sound. I have a couple of suggestions to improve the robustness of the controller's update operations.

gemini-code-assist · 2026-03-17T09:03:24Z

controllers/jenkins/pipelinerun/pipelinerun_controller.go

+		pipelineRunCopied.ObjectMeta.Finalizers = sliceutil.RemoveString(pipelineRunCopied.ObjectMeta.Finalizers, func(item string) bool {
+			return item == v1alpha3.PipelineRunFinalizerName
+		})
+		err = r.Update(context.TODO(), pipelineRunCopied)


This update to remove the finalizer should be wrapped in a retry.RetryOnConflict loop to handle potential conflicts gracefully. This is a standard pattern in controllers to avoid reconciliation failures due to object modifications between read and write operations. You can see an example of this pattern in the updateStatus function in this file.

Additionally, please use the ctx from the Reconcile function instead of context.TODO().

gemini-code-assist · 2026-03-17T09:03:24Z

controllers/jenkins/pipelinerun/pipelinerun_controller.go

+	// add finalizer if it does not exist
+	if !sliceutil.HasString(pipelineRunCopied.ObjectMeta.Finalizers, v1alpha3.PipelineRunFinalizerName) {
+		pipelineRunCopied.ObjectMeta.Finalizers = append(pipelineRunCopied.ObjectMeta.Finalizers, v1alpha3.PipelineRunFinalizerName)
+		if err := r.Update(ctx, pipelineRunCopied); err != nil {


This update to add the finalizer should be wrapped in a retry.RetryOnConflict loop to handle potential conflicts gracefully. This is a standard pattern in controllers to avoid reconciliation failures due to object modifications between read and write operations. You can see an example of this pattern in the updateStatus function in this file.

stoneshi-yunify · 2026-03-18T03:12:00Z

controllers/jenkins/pipelinerun/pipelinerun_controller.go

-		} else {
-			k8sutil.RemoveFinalizer(&pipelineRunCopied.ObjectMeta, v1alpha3.PipelineRunFinalizerName)
-			err = r.Update(context.TODO(), pipelineRunCopied)
+			return ctrl.Result{}, err


i'm afraid this error will occur continuously in some cases, for example, the jenkins job has already been deleted, or the jenkins job can not be deleted due to some reasons (running, network issues etc).

suggest just log the error and don't return, continue the below code

stoneshi-yunify · 2026-03-18T03:12:56Z

controllers/jenkins/pipelinerun/pipelinerun_controller.go

 	if !pipelineRunCopied.ObjectMeta.DeletionTimestamp.IsZero() {
-		if err = jHandler.deleteJenkinsJobHistory(pipelineRunCopied); err != nil {
+		// if the annotation value is true, we should keep the record in Jenkins
+		if keep, err := strconv.ParseBool(pipelineRunCopied.Annotations[v1alpha3.PipelineRunKeepJenkinsRecordAnnoKey]); err == nil && keep {


pipelineRunCopied.Annotations may be nil map.

We do not perform write operations on the map here. Reading a nil map will return its default empty value, and no panic will occur.

Signed-off-by: renyunkang <rykren1998@gmail.com>

stoneshi-yunify · 2026-03-18T08:19:05Z

/lgtm

renyunkang requested a review from stoneshi-yunify March 17, 2026 09:00

gemini-code-assist bot reviewed Mar 17, 2026

View reviewed changes

renyunkang force-pushed the master branch from c3408ae to 3677b78 Compare March 17, 2026 09:24

stoneshi-yunify requested changes Mar 18, 2026

View reviewed changes

support to delete pipelinerun

d5e51b6

Signed-off-by: renyunkang <rykren1998@gmail.com>

renyunkang force-pushed the master branch from 3677b78 to d5e51b6 Compare March 18, 2026 07:10

stoneshi-yunify merged commit 353f62c into kubesphere:master Mar 18, 2026
1 of 2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

support to delete pipelinerun#1069

support to delete pipelinerun#1069
stoneshi-yunify merged 1 commit intokubesphere:masterfrom
renyunkang:master

renyunkang commented Mar 17, 2026

Uh oh!

gemini-code-assist bot commented Mar 17, 2026

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Mar 17, 2026

Uh oh!

gemini-code-assist bot Mar 17, 2026

Uh oh!

stoneshi-yunify Mar 18, 2026

Uh oh!

renyunkang Mar 18, 2026

Uh oh!

stoneshi-yunify Mar 18, 2026

Uh oh!

renyunkang Mar 18, 2026

Uh oh!

stoneshi-yunify commented Mar 18, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

renyunkang commented Mar 17, 2026

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for reviewers:

Does this PR introduce a user-facing change??

Uh oh!

gemini-code-assist bot commented Mar 17, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Mar 17, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Mar 17, 2026

Choose a reason for hiding this comment

Uh oh!

stoneshi-yunify Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

renyunkang Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

stoneshi-yunify Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

renyunkang Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

stoneshi-yunify commented Mar 18, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants